Ficha técnica

Seguridad

📘 BTG Id

El Authorization Server de BTG Empresas se llama BTG Id. Usando el BTG Id, una aplicación asociada puede obtener consentimiento y autorización para ejecutar operaciones en las APIs de BTG en nombre del cliente. Para saber más, acceda a la documentación del BTG Id

Alcances necesarios

El token para consumir la API de Onboarding consignado debe ser generado utilizando Client Credentials.

Alcance	Descripción
empresas.btgpactual.com/payer-register	Permite realizar el onboarding de consignado

Eventos de webhook

El payload disponible a continuación representa el contenido del campo data.

Eventos	Descripciones
payroll-loan-payer.authorized	Notificación de cambios de estado a autorizado.
payroll-loan-payer.disapproved	Notificación de cambios de estado a rechazado.
payroll-loan-payer.error	Notificación de cambios de estado a error.
payroll-loan-payer.pending	Notificación de cambios de estado a pendiente de ajuste.
payroll-loan-payer.pending_analysis	Notificación de cambios de estado a pendiente de análisis.

payroll-loan-payer.*

{
	"taxId": "111444445000333",
	"onboardingId": "444e9444-6d27-4281-b01b-c8d14446d184",
  "timestamp": "2025-07-23T13:18:30.1553811+00:00",
  "status": "REPROVADO",
  "reasons": [
		"Entidade não encontrada na Receita Federal"
	]
}